DescribeTags

Description

call DescribeTags query tag list.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeTags

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
DistinctKey	BODY	boolean	No	false	whether it is a DistinctKey. Value:true or false.
PageSize	BODY	integer	No	50	Number of single-page results, interface default 50, maximum 100.
PageNumber	BODY	integer	No	1	instance list page number, start value 1, default value 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
LoadBalancerId	BODY	string	No	lb-bp1b6c719dfa08ex****	load balancing instance ID.
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID of the load balancing instance.
version	BODY	string	No	2016-01-01	version of api
Tags	BODY	string	No	[{"TagKey":"Key1","TagValue":"Value1"},{"TagKey":"Key2","TagValue":"Value2"}]	list of tags to query.

Return data

Name	Type	Sample value	Description
InstanceCount	integer	10	the total number of instances bound by this tag.
TotalCount	integer	1	The total number of instances obtained according to the filter conditions.
PageSize	integer	50	Number of single-page results, interface default 50, maximum 100.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
PageNumber	integer	1	instance list page number, start value 1, default value 1.
TagSet		No sample value for this parameter.	No description for this parameter.
TagKey	string	test	tag Key.
TagValue	string	api	tag value.
TagSets	array of tagset	No sample value for this parameter.	Tag list.

Example

Successful Response example

{
 "InstanceCount":"10",
 "TotalCount":"1",
 "PageSize":"50",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "PageNumber":"1",
 "TagSet":"",
 "TagKey":"test",
 "TagValue":"api",
 "TagSets":""
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribeVServerGroupAttribute

sidebar_position: 3

DescribeVServerGroupAttribute

Description

call the DescribeVServerGroupAttribute to query the details of the server group.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeVServerGroupAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
VServerGroupId	BODY	string	Yes	rsp-cige6****	virtual server group ID.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID of the load balancing instance.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
VServerGroupId	string	rsp-cige6****	virtual server group ID.
ServerType	string	ecs	No description for this parameter.
Type	string	ecs	backend server type, value: ecs(default):ECS instance eni: ENI instance
ServerId	string	vm-233	ECS instance ID.
Description	string	server group description.	server group description.
RequestId	string	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C	request ID.
BackendServer		No sample value for this parameter.	No description for this parameter.
Port	integer	90	the port used by the backend server.
VServerGroupName	string	Group1	virtual server group name. It is 1 to 80 characters in length and supports Chinese, letters, numbers, dashes (-), forward slashes (/), periods (.), and underscores (_).
BackendServers	array of backendserver	No sample value for this parameter.	backend server list.
Weight	integer	100	the weight of the back-end server.

Example

Successful Response example

{
 "VServerGroupId":"rsp-cige6****",
 "ServerType":"ecs",
 "Type":"ecs",
 "ServerId":"vm-233",
 "Description":"server group description.",
 "RequestId":"9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
 "BackendServer":"",
 "Port":"90",
 "VServerGroupName":"Group1",
 "BackendServers":"",
 "Weight":"100"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}